home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d2 / pophelp.arc / HELP.DOC < prev    next >
Encoding:
Text File  |  1988-06-27  |  15.2 KB  |  493 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.                             HELP / POP-HELP USER'S GUIDE
  30.  
  31.                             Copyright 1987, HELP SOFTWARE
  32.                                   16706 Bradley Ct.
  33.                                   Belton, MO 64012
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.                                   TABLE OF CONTENTS
  81.  
  82.  
  83.           SHAREWARE CONCEPT  .............................  1
  84.  
  85.           WHAT DOES HELP!! DO ?? .........................  1
  86.  
  87.           INSTALLING HELP!!  .............................  2
  88.  
  89.           USING HELP!!  ..................................  3
  90.  
  91.           DIFFERENCES BETWEEN HELP!! AND POP-HELP  .......  4
  92.  
  93.           MODIFYING AND ADDING HELP!! COMMANDS  ..........  5
  94.  
  95.           USING CONVERT  .................................  6
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.                                                                      Page 1
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.                                   SHAREWARE CONCEPT
  131.  
  132.  
  133.           HELP!! and POP-HELP represent many months of very hard work.  I
  134.           urge you to support the Shareware concept and fight the high cost
  135.           of software.  If you find this program useful, please send $15.00
  136.           to:
  137.  
  138.                                  HELP SOFTWARE
  139.                                  16706 Bradley Ct.
  140.                                  Belton, MO 64012
  141.  
  142.  
  143.           Whether you find this program useful or not, you are encouraged
  144.           to share this program with others, but not for money.
  145.  
  146.           Both HELP!! and POP-HELP have been thoroughly tested, but if you
  147.           should find a bug or have an idea how HELP!! could be improved,
  148.           please let me know.
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.                                WHAT DOES HELP!! DO ??
  156.  
  157.           HELP!! is an on-line reference manual.  You can create your own
  158.           file of commands so that HELP!! can be tailored to your needs. 
  159.           HELP!! comes with a text file (HELPTEXT) that contains a complete
  160.           listing of DOS commands.  It is designed to be as flexible as
  161.           possible.
  162.  
  163.           HELP!! is available from the DOS command line at any time.  POP-
  164.           HELP is a pop-up or memory resident version of HELP!!  There are
  165.           a few minor differences between HELP and POP-HELP and they are
  166.           explained in a later section.
  167.  
  168.           The text file that HELP!! uses (HELPTEXT) is included on this
  169.           disk.  You can add commands, edit commands, or personalize
  170.           HELPTEXT any way you want.  HELPTEXT currently contains DOS
  171.           commands and descriptions, but if you want to add BASIC commands
  172.           or commands from any programming language or application program
  173.           it should work just fine.  (See the section on Modifying and
  174.           Adding HELP!! Commands for instructions).
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.                                                                      Page 2
  183.  
  184.  
  185.                                   INSTALLING HELP!!
  186.  
  187.  
  188.           The installation of HELP!! is either a one or two step process. 
  189.           If your copy of HELP!! was downloaded from a bulletin board, you
  190.           may need to run the CONVERT program before HELP!! will be usable.
  191.  
  192.           Here's how to tell if you need to run CONVERT.  Check your
  193.           directory for two files.  If you do not have the files HELP.NDX
  194.           and HELP.DAT, then you will need to run CONVERT.  (See the
  195.           instructions in the section labeled USING CONVERT).
  196.  
  197.           Next type SETUP and press Enter.  A screen will be displayed
  198.           prompting you to enter several pieces of information.
  199.  
  200.           The first thing that SETUP will ask for is the drive and path
  201.           where the file HELP.NDX can be found.  HELP.NDX is the index file
  202.           that HELP!! and POP-HELP use.  Just type in the name of the drive
  203.           and directory for HELP.NDX (Example  C:\HELP  or A:).
  204.  
  205.           The next thing that SETUP will ask for is the drive and path
  206.           where the file HELP.DAT can be found.  HELP.DAT is the data file
  207.           that HELP!! and POP-HELP use.  Just type in the name of the drive
  208.           and directory for HELP.DAT (Example  C:\HELP  or A:).
  209.  
  210.           Next SETUP will ask you if you want to force color to monochrome. 
  211.           Both HELP!! and POP-HELP are quite capable of figuring out what
  212.           type of adapter that you have.  However, if you have a monochrome
  213.           monitor that is attached to a color adapter, (such as a Compaq
  214.           Computer or a composite monitor of some sort) you may have
  215.           trouble reading the screen because of the colors used.  By
  216.           forcing color to monochrome you will be able to read the display
  217.           much easier.
  218.  
  219.           The last thing that SETUP will ask you for is the key sequence to
  220.           use to start POP-HELP.  Remember that POP-HELP is the pop-up or
  221.           memory resident version of HELP!!.  The key sequences that can be
  222.           used are ALT and 0 through 9, ALT and A through Z, ALT and F1
  223.           through F10, CTRL-Home, CTRL-End, CTRL-PgUp, and CTRL-PgDn.  You
  224.           should have enough choices so that POP-HELP's startup keystrokes
  225.           won't interfere with your other programs.
  226.  
  227.           When you are finished entering the required information press
  228.           F10.  SETUP will ask you if you are sure.  Press "Y" to save and
  229.           exit or "N" to return to SETUP.
  230.  
  231.           If you want to ESCape without saving any changes simply press
  232.           ESCape.  SETUP will ask you if you are sure.  Press "Y" to exit
  233.           without saving or "N" to return to SETUP.
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.                                                                      Page 3
  241.  
  242.           You may use the up and down arrow keys to move back and forth
  243.           between the different choices.
  244.  
  245.  
  246.  
  247.  
  248.  
  249.                                     USING HELP!!
  250.  
  251.           HELP!! and POP-HELP are so easy to use and you will probably not
  252.           even need to use the documentation.  Nevertheless, documentation
  253.           is provided.
  254.  
  255.           There are two key differences between HELP!! and POP-HELP and you
  256.           will want to be sure to read the section that explains the
  257.           differences.
  258.  
  259.           Before you are able to use POP-HELP, you need to load it into
  260.           memory by typing POP-HELP and pressing enter.
  261.  
  262.           Once you have loaded POP-HELP, just press the key sequence that
  263.           you defined (using SETUP) to start POP-HELP.  When you press the
  264.           proper key sequence, POP-HELP will display the list of available
  265.           commands.
  266.  
  267.           To start HELP!! all that you need to do is enter HELP and an
  268.           optional command name from the DOS command line.
  269.  
  270.           The syntax for HELP!! is:  HELP [COMMAND]
  271.  
  272.           [COMMAND] is optional.  If HELP is entered without a COMMAND, a
  273.           list of commands will be displayed and you will be able to select
  274.           one using the cursor keys.  
  275.  
  276.           If HELP!! is entered with a COMMAND name, HELP!! will search the
  277.           list of commands for the command entered.  If HELP!! finds the
  278.           command entered then the list of commands will not be shown.
  279.           Instead the HELP information for the command entered will be
  280.           displayed.
  281.  
  282.           If COMMAND is not found then the list of available commands will
  283.           be displayed and you may scroll through them using the cursor
  284.           keys.
  285.  
  286.           While you are in the list of commands, you may use the up and
  287.           down arrows to scroll one COMMAND NAME at a time, the PgUp and
  288.           PgDn keys to scroll one screen at a time, and the Home and End
  289.           keys to scroll to the first and last COMMAND NAMES.  Enter will
  290.           select the COMMAND that is highlighted and ESCape will exit the
  291.           program.
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.                                                                      Page 4
  299.  
  300.           While you are in the window which displays the HELP!! text, you
  301.           may use the up and down arrows to scroll one line at a time, the
  302.           PgUp and PgDn keys to scroll one screen at a time, and the Home
  303.           and End keys to scroll to the first and last lines.  Pressing the
  304.           ESCape key will allow you to exit.
  305.  
  306.           Any time that the second window (HELP window) is displayed, you
  307.           may display the COMMAND WINDOW by pressing C.
  308.  
  309.           The COMMAND WINDOW provides an easy way to enter the command that
  310.           you need help with.  The COMMAND WINDOW is designed to allow you
  311.           to enter the command that you have requested help with while you
  312.           are still able to read the help information.  
  313.  
  314.           Even when you are in the COMMAND WINDOW you still have access to
  315.           all of the information in the HELP window (second window).  You
  316.           are still able to scroll the help information up and down using
  317.           the cursor keys.
  318.  
  319.           When you are using HELP, the command that you enter using the
  320.           COMMAND WINDOW will be processed immediately and you will remain
  321.           in HELP!!  
  322.  
  323.           When you enter a command using the COMMAND WINDOW with POP-HELP,
  324.           nothing will happen right away.  In fact, nothing will happen at
  325.           all until you exit POP-HELP.  When you do exit POP-HELP, the
  326.           command that you entered will be sent to the keyboard buffer just
  327.           as you entered it.
  328.  
  329.           REMHELP is available if you need to remove POP-HELP from memory. 
  330.           All that you need to do is type REMHELP and POP-HELP will be
  331.           removed from memory.
  332.  
  333.  
  334.  
  335.  
  336.  
  337.                         DIFFERENCES BETWEEN HELP!! AND POP-HELP
  338.  
  339.           There are two major differences between HELP!! and POP-HELP
  340.  
  341.           1.  When using HELP!! (from the command line) you may specify the
  342.           optional command name.  An example of this would be invoking
  343.           HELP!! with the command  HELP MODE.  After issuing this command,
  344.           HELP!! will look in its list of commands to see if it can find
  345.           the command MODE.  If it finds the MODE command, then HELP!! will
  346.           immediately display the information available for MODE.  If
  347.           HELP!! cannot find the MODE command then the list of available
  348.           commands will be displayed.  
  349.  
  350.           POP-HELP obviously has no way to allow for this since it is
  351.           invoked by a HOT key sequence.
  352.  
  353.  
  354.  
  355.  
  356.  
  357.                                                                      Page 5
  358.  
  359.  
  360.  
  361.  
  362.  
  363.           2.  The second difference has to do with the way that HELP!! and
  364.           POP-HELP handle a command entered from the command window.
  365.  
  366.           If you enter a command from the command window using HELP!! it
  367.           will be executed immediately and you will remain inside HELP!!
  368.  
  369.           When you enter a command from the command window using POP-HELP
  370.           nothing will happen right away.  In fact nothing will happen
  371.           until you exit POP-HELP.  When you do exit POP-HELP, however, the
  372.           command that you entered will be passed to the keyboard buffer
  373.           just as you entered it.
  374.  
  375.  
  376.  
  377.  
  378.  
  379.                         MODIFYING AND ADDING HELP!! COMMANDS
  380.  
  381.           One of the great things about HELP!! and POP-HELP is that you can
  382.           add your own commands or you can change the text for the commands
  383.           that are supplied.
  384.  
  385.           If you want to add to the list of DOS commands you can simply
  386.           edit the HELPTEXT file using a word processor or the EDLIN line
  387.           editor.  You do not, however have to use the HELPTEXT file.  If
  388.           you wish, you may create a completely new file using any name
  389.           that you choose.
  390.  
  391.  
  392.                                     IMPORTANT:
  393.  
  394.           When you are modifying the text to be used by HELP!! there are a
  395.           few things that you must remember.
  396.  
  397.           1.  The maximum length of any line is 40 characters.  Any text
  398.           over 40 characters will be cut off.
  399.  
  400.           2.  HELP!! and POP-HELP can handle a maximum of 500 different
  401.           commands.  Each command may have up to 150 lines of text.  Each
  402.           command name may be up to 11 characters long.
  403.  
  404.           3.  HELP!! cannot use a text file.  After you have finished
  405.           modifying HELPTEXT, you must run the CONVERT program to create an
  406.           index file and a data file that will be used by HELP!! and POP-
  407.           HELP.
  408.  
  409.           4.  CONVERT is very particular about how the commands are
  410.  
  411.  
  412.  
  413.  
  414.  
  415.                                                                      Page 6
  416.  
  417.           separated.  Be sure to read below about how new commands are
  418.           recognized. (Using Ctrl-A)
  419.  
  420.  
  421.  
  422.  
  423.  
  424.                                SPECIAL CHARACTERS:
  425.  
  426.           There are a few special characters which will cause special
  427.           effects when used in the HELPTEXT file.  They are listed below.
  428.  
  429.           ^A (Ctrl-A) - notes the start of a new command.  CONVERT expects
  430.           Ctrl-A to be the first character in the text file being
  431.           converted.  CONVERT also expects the command name to immediately
  432.           follow the Ctrl-A.  You may want to take a look at how the
  433.           HELPTEXT file is set up.  
  434.  
  435.           An example of how CONVERT would expect a text file to look is
  436.           given below.
  437.  
  438.           ^ANEW COMMAND
  439.           This is the start of a new command.
  440.  
  441.           ^A2nd COMMAND
  442.           Here is some text for the second
  443.           command.
  444.  
  445.  
  446.           ^E (Ctrl-E) - makes text yellow on a color monitor or high
  447.           intensity white on a monochrome monitor.
  448.  
  449.           ^B (Ctrl-B) - makes text green on a color monitor or high
  450.           intensity white on a monochrome monitor.
  451.  
  452.           ^N (Ctrl-N) - creates blinking text.  Text will be blinking red
  453.           on a color monitor or blinking high intensity white on a
  454.           monochrome monitor.
  455.  
  456.           ^  (Shift-6) - returns text to normal.  Normal text is light blue
  457.           on a color monitor or light gray on a monochrome monitor.
  458.  
  459.  
  460.  
  461.  
  462.                                    USING CONVERT:
  463.  
  464.           After you modify your file, you will need to run CONVERT to make
  465.           your changes usable by HELP!! and POP-HELP.
  466.  
  467.           When you run convert, you will be asked for the full path where
  468.           the text file to be converted is located.  For instance, if you
  469.  
  470.  
  471.  
  472.  
  473.  
  474.                                                                      Page 7
  475.  
  476.           are using the file HELPTEXT and it is located in C:\DATAFILE then
  477.           enter C:\DATAFILE\HELPTEXT at the > prompt.
  478.  
  479.           You will then be asked the full path where you want the converted
  480.           files to be placed.  If you want the files placed in C:\HELP then
  481.           enter C:\HELP, if you want the files placed in the current
  482.           directory then just press enter.
  483.  
  484.           At this point, CONVERT will display the commands that it is
  485.           converting until it has converted the entire file.
  486.  
  487.           After this is finished, you are ready to use HELP!! or POP-HELP
  488.           and your new commands or modified commands will be included.
  489.  
  490.  
  491.  
  492.  
  493.